﻿namespace System.Modules.Constants
{
    /// <summary>
    /// Character combinations consisting of a backslash (\) followed by a letter or by a combination of digits are called "escape sequences." To represent a newline character, single quotation mark, or certain other characters in a character constant, you must use escape sequences. An escape sequence is regarded as a single character and is therefore valid as a character constant. 
    /// Escape sequences are typically used to specify actions such as carriage returns and tab movements on terminals and printers. They are also used to provide literal representations of nonprinting characters and characters that usually have special meanings, such as the double quotation mark ("). The following table lists the ANSI escape sequences and what they represent.
    /// Note that the question mark preceded by a backslash (\?) specifies a literal question mark in cases where the character sequence would be misinterpreted as a trigraph. See Trigraphs for more information
    /// </summary>
    public class EscapeCharacter
    {
        /// <summary>
        /// Bell (alert)
        /// </summary>
        public const string ALERT = "\a";

        /// <summary>
        /// Backspace
        /// </summary>
        public const string BACKSPACE = "\b";

        /// <summary>
        /// Formfeed
        /// </summary>
        public const string FORMFEED = "\f";

        /// <summary>
        /// New line
        /// </summary>
        public const string NEW_LINE = "\n";

        /// <summary>
        /// Carriage return
        /// </summary>
        public const string CARRIAGE_RETURN = "\r";

        /// <summary>
        /// Horizontal tab
        /// </summary>
        public const string HORIZONTAL_TAB = "\t";

        /// <summary>
        /// Vertical tab
        /// </summary>
        public const string VERTICAL_TAB = "\v";

        /// <summary>
        /// Single quotation mark
        /// </summary>
        public const string SINGLE_QUOTATION_MARK = "\'";

        /// <summary>
        /// Double quotation mark
        /// </summary>
        public const string DOUBLE_QUOTATION_MARK = "\"";

        /// <summary>
        /// Backslash
        /// </summary>
        public const string BACKSLASH = "\\";
    }
}
